Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dev.ej/prep for mkdocs #224

Merged
merged 2 commits into from
Jun 21, 2024
Merged

Dev.ej/prep for mkdocs #224

merged 2 commits into from
Jun 21, 2024

Conversation

joanise
Copy link
Member

@joanise joanise commented Jun 21, 2024

PR Goal?

Add a link to the old Sphinx base documentation to point to the new location.

While I'm here, fix two syntactic errors so the latest version on https://readalong-studio.readthedocs.io/ will display correctly. (I had to fix them for the convert to .md to work correctly.)

Fixes?

Prepares the way for #213
Related to #223

Feedback sought?

sanity checking

Priority?

normal

Tests added?

n/a

How to test?

locally build and examine the docs:

cd docs
pip install -r requirements.txt
make html    # or: sphinx-build -M html . _build
cd _build/html
python -m http.server

then navigate to http://127.0.0.1:8000 and see:
image
then make sure the link forward to the new docs is good.

Confidence?

high

Version change?

no

Required follow-up action

@roedoejet Once we merge this we'll need to do a final documentation push to readthedocs and make sure https://readalong-studio.readthedocs.io/en/latest/ gets updated with the forward link.

Copy link

codecov bot commented Jun 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.23%. Comparing base (396b2f1) to head (a80c35e).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #224      +/-   ##
==========================================
- Coverage   87.45%   87.23%   -0.23%     
==========================================
  Files          21       21              
  Lines        1770     1770              
  Branches      321      321              
==========================================
- Hits         1548     1544       -4     
- Misses        186      189       +3     
- Partials       36       37       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@roedoejet roedoejet merged commit a5f5368 into main Jun 21, 2024
6 of 8 checks passed
@roedoejet roedoejet deleted the dev.ej/prep-for-mkdocs branch June 21, 2024 21:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants